Standardize documentation for ReadtheDocs #360
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
samjwu
added
dependencies
LisaDelaney
approved these changes
Jan 12, 2024
stanleytsang-amd
added a commit
that referenced
this pull request
Jan 17, 2024
* StreamHPC 2023-10-30 (#338) * fix: Restore compatibility with latest rocPRIM rocPRIM changed the API of `lookback_scan_state`, update usage to match. * fix: doxygen warnings --------- Co-authored-by: Gergely Meszaros <gergely@streamhpc.com> * Fixed segfault in HIP binary search (#342) * Fixed segfault in HIP binary search By using a different way of host->device and device->host copies. The copy using the class "reference" cannot have access to the state of the system. This caused a segfault when the HIP stream selector system is used, because it tries to access the system (nullptr) for a stream. The incantation that is the new implementation is borrowed from the cuda system. * Updated changelog * readme and changelog updates (#346) * Include hipstdpar in rocThrust packages (#343) * Add hipstdpar header and target * Add `hipstdpar` to package provides for rocThrust * Move hipstdpar to match thrust convention * Update hipstdpar_lib.hpp Removed cppreference references and debug message. * Update hipstdpar_lib.hpp Update license. --------- Co-authored-by: Alex Voicu <alexandru.voicu@amd.com> * Bump urllib3 from 1.26.17 to 1.26.18 in /docs/.sphinx (#334) Bumps [urllib3](https://github.com/urllib3/urllib3) from 1.26.17 to 1.26.18. - [Release notes](https://github.com/urllib3/urllib3/releases) - [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst) - [Commits](urllib3/urllib3@1.26.17...1.26.18) --- updated-dependencies: - dependency-name: urllib3 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump cryptography from 41.0.4 to 41.0.6 in /docs/.sphinx (#347) Bumps [cryptography](https://github.com/pyca/cryptography) from 41.0.4 to 41.0.6. - [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst) - [Commits](pyca/cryptography@41.0.4...41.0.6) --- updated-dependencies: - dependency-name: cryptography dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump rocm-docs-core from 0.25.0 to 0.30.3 in /docs/.sphinx (#354) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.25.0 to 0.30.3. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](ROCm/rocm-docs-core@v0.25.0...v0.30.3) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * 6.0 final mergeback to develop (#357) * Update changelog with correct categorizations (#328) * Change device_malloc specialization to instantiation (#332) * Update changelog and version for 6.0 (#340) * Cherry pick binary search fix for 6.0 (#345) Co-authored-by: Lőrinc Serfőző <mfep@users.noreply.github.com> --------- Co-authored-by: Lőrinc Serfőző <mfep@users.noreply.github.com> * Standardize documentation for ReadtheDocs (#360) * Standardize documentation for ReadtheDocs * Use custom venv for RTD doxygen 1.9.8 * Add CODEOWNERS file (#361) * Bump jinja2 from 3.1.2 to 3.1.3 in /docs/sphinx (#362) Bumps [jinja2](https://github.com/pallets/jinja) from 3.1.2 to 3.1.3. - [Release notes](https://github.com/pallets/jinja/releases) - [Changelog](https://github.com/pallets/jinja/blob/main/CHANGES.rst) - [Commits](pallets/jinja@3.1.2...3.1.3) --- updated-dependencies: - dependency-name: jinja2 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump gitpython from 3.1.37 to 3.1.41 in /docs/sphinx (#363) Bumps [gitpython](https://github.com/gitpython-developers/GitPython) from 3.1.37 to 3.1.41. - [Release notes](https://github.com/gitpython-developers/GitPython/releases) - [Changelog](https://github.com/gitpython-developers/GitPython/blob/main/CHANGES) - [Commits](gitpython-developers/GitPython@3.1.37...3.1.41) --- updated-dependencies: - dependency-name: gitpython dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump rocm-docs-core from 0.30.3 to 0.31.0 in /docs/sphinx (#364) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.30.3 to 0.31.0. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](ROCm/rocm-docs-core@v0.30.3...v0.31.0) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update links in README file - Update links to ROCm repositories that are now in the ROCm Organization. - Fixed broken links to the "Supported Hardware" documentation. --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Nara <nara@streamhpc.com> Co-authored-by: Gergely Meszaros <gergely@streamhpc.com> Co-authored-by: Lőrinc Serfőző <mfep@users.noreply.github.com> Co-authored-by: Lisa <lisajdelaney@gmail.com> Co-authored-by: Lauren Wrubleski <Lauren.Wrubleski@amd.com> Co-authored-by: Alex Voicu <alexandru.voicu@amd.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Sam Wu <sam.wu2@amd.com> Co-authored-by: David Galiffi <dgaliffi@amd.com>
stanleytsang-amd
added a commit
that referenced
this pull request
Feb 6, 2024
…#378) * StreamHPC 2023-10-30 (#338) * fix: Restore compatibility with latest rocPRIM rocPRIM changed the API of `lookback_scan_state`, update usage to match. * fix: doxygen warnings --------- Co-authored-by: Gergely Meszaros <gergely@streamhpc.com> * Fixed segfault in HIP binary search (#342) * Fixed segfault in HIP binary search By using a different way of host->device and device->host copies. The copy using the class "reference" cannot have access to the state of the system. This caused a segfault when the HIP stream selector system is used, because it tries to access the system (nullptr) for a stream. The incantation that is the new implementation is borrowed from the cuda system. * Updated changelog * readme and changelog updates (#346) * Include hipstdpar in rocThrust packages (#343) * Add hipstdpar header and target * Add `hipstdpar` to package provides for rocThrust * Move hipstdpar to match thrust convention * Update hipstdpar_lib.hpp Removed cppreference references and debug message. * Update hipstdpar_lib.hpp Update license. --------- Co-authored-by: Alex Voicu <alexandru.voicu@amd.com> * Bump urllib3 from 1.26.17 to 1.26.18 in /docs/.sphinx (#334) Bumps [urllib3](https://github.com/urllib3/urllib3) from 1.26.17 to 1.26.18. - [Release notes](https://github.com/urllib3/urllib3/releases) - [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst) - [Commits](urllib3/urllib3@1.26.17...1.26.18) --- updated-dependencies: - dependency-name: urllib3 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump cryptography from 41.0.4 to 41.0.6 in /docs/.sphinx (#347) Bumps [cryptography](https://github.com/pyca/cryptography) from 41.0.4 to 41.0.6. - [Changelog](https://github.com/pyca/cryptography/blob/main/CHANGELOG.rst) - [Commits](pyca/cryptography@41.0.4...41.0.6) --- updated-dependencies: - dependency-name: cryptography dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump rocm-docs-core from 0.25.0 to 0.30.3 in /docs/.sphinx (#354) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.25.0 to 0.30.3. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](ROCm/rocm-docs-core@v0.25.0...v0.30.3) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * 6.0 final mergeback to develop (#357) * Update changelog with correct categorizations (#328) * Change device_malloc specialization to instantiation (#332) * Update changelog and version for 6.0 (#340) * Cherry pick binary search fix for 6.0 (#345) Co-authored-by: Lőrinc Serfőző <mfep@users.noreply.github.com> --------- Co-authored-by: Lőrinc Serfőző <mfep@users.noreply.github.com> * Standardize documentation for ReadtheDocs (#360) * Standardize documentation for ReadtheDocs * Use custom venv for RTD doxygen 1.9.8 * Add CODEOWNERS file (#361) * Bump jinja2 from 3.1.2 to 3.1.3 in /docs/sphinx (#362) Bumps [jinja2](https://github.com/pallets/jinja) from 3.1.2 to 3.1.3. - [Release notes](https://github.com/pallets/jinja/releases) - [Changelog](https://github.com/pallets/jinja/blob/main/CHANGES.rst) - [Commits](pallets/jinja@3.1.2...3.1.3) --- updated-dependencies: - dependency-name: jinja2 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump gitpython from 3.1.37 to 3.1.41 in /docs/sphinx (#363) Bumps [gitpython](https://github.com/gitpython-developers/GitPython) from 3.1.37 to 3.1.41. - [Release notes](https://github.com/gitpython-developers/GitPython/releases) - [Changelog](https://github.com/gitpython-developers/GitPython/blob/main/CHANGES) - [Commits](gitpython-developers/GitPython@3.1.37...3.1.41) --- updated-dependencies: - dependency-name: gitpython dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump rocm-docs-core from 0.30.3 to 0.31.0 in /docs/sphinx (#364) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.30.3 to 0.31.0. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/RadeonOpenCompute/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](ROCm/rocm-docs-core@v0.30.3...v0.31.0) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update links in README file - Update links to ROCm repositories that are now in the ROCm Organization. - Fixed broken links to the "Supported Hardware" documentation. * Fix misuses of `for_each`'s return value. Relocate header. (#368) * Bump rocm-docs-core from 0.31.0 to 0.33.0 in /docs/sphinx (#372) Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.31.0 to 0.33.0. - [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](ROCm/rocm-docs-core@v0.31.0...v0.33.0) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add codeowners for documentation (#370) * Add codeowners for documentation * Update CODEOWNERS --------- Co-authored-by: samjwu <samjwu@users.noreply.github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Nara <nara@streamhpc.com> Co-authored-by: Gergely Meszaros <gergely@streamhpc.com> Co-authored-by: Lőrinc Serfőző <mfep@users.noreply.github.com> Co-authored-by: Lisa <lisajdelaney@gmail.com> Co-authored-by: Lauren Wrubleski <Lauren.Wrubleski@amd.com> Co-authored-by: Alex Voicu <alexandru.voicu@amd.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Sam Wu <sam.wu2@amd.com> Co-authored-by: David Galiffi <dgaliffi@amd.com> Co-authored-by: samjwu <samjwu@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Apply the following changes to project documentation for ReadtheDocs:
add version number to documentation left navigation bar and page title
add an "About" section with a license page
enable htmlzip, pdf, epub formats when publishing on Read the Docs
set pdf title, author, copyright, and version
rename .sphinx/.doxygen to sphinx/doxygen
update rocm-docs-core dependency
update dependabot config
relates to ROCm/rocm-docs-core#330
Note
Runs a custom virtual environment via conda (mambaforge) for ReadtheDocs for doxygen 1.9.8 due to doxygen 1.9.1 (default for Ubuntu 22.04) segfaulting on rocThrust documentation